/*
 *    Copyright 2009-2021 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.plugin;

import java.util.Properties;

/**
 * @author Clinton Begin
 */
public interface Interceptor {
  /**
   * 可被拦截的4个类型
   * 1.Executor：拦截执行器的方法。
   * 2.ParameterHandler：拦截参数的处理。
   * 3.ResultHandler：拦截结果集的处理。
   * 4.StatementHandler：拦截Sql语法构建的处理。
   */

  // invocation 封装了拦截的类，方法，方法参数
  // 是实现拦截逻辑的地方，内部要通过invocation.proceed()显式地推进责任链前进，也就是调用下一个拦截器拦截目标方法。
  Object intercept(Invocation invocation) throws Throwable;

  // 通过sqlSessionFactory 创建SqlSession 时会创建对应的 Executor 对象
  // 创建 Executor 对象后，会调用 interceptorChain 属性的 pluginAll()方法，遍历所有注册的拦截器 Interceptor，调用其plugin
  // 就是用当前这个拦截器生成对目标target的JDK代理，实际是通过Plugin.wrap(target,this) 来完成的
  default Object plugin(Object target) {
    return Plugin.wrap(target, this);
  }

  // 拦截器对象实例化完就调用该方法进行一些初始化，然后再加入拦截器
  default void setProperties(Properties properties) {
    // NOP
  }

}
